Security News
NIST Misses 2024 Deadline to Clear NVD Backlog
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
jest-docblock
Advanced tools
`jest-docblock` is a package that can extract and parse a specially-formatted comment called a "docblock" at the top of a file.
The jest-docblock package is used to parse and manipulate docblocks - comments at the top of a file that are often used to provide metadata about the file, such as descriptions, authors, and licenses. It is commonly used in the Jest testing framework to handle such metadata in test files.
Parsing docblocks
This feature allows you to parse the contents of a file to extract the metadata contained within a docblock. The parse function returns an object where each key is a tag from the docblock.
const { parse } = require('jest-docblock');
const contents = `/**
* This is a docblock
*
* @flow
*/
const foo = 'bar';`;
const docblock = parse(contents);
console.log(docblock);
Extracting docblock
This feature allows you to extract the raw docblock as a string from the contents of a file. This can be useful if you want to manipulate the docblock as a whole or use it for documentation purposes.
const { extract } = require('jest-docblock');
const contents = `/**
* This is a docblock
*
* @flow
*/
const foo = 'bar';`;
const docblockString = extract(contents);
console.log(docblockString);
Printing docblock
This feature allows you to take an object representing a docblock and print it back into the docblock format. This is useful for modifying or adding new metadata to a file's docblock.
const { print } = require('jest-docblock');
const docblock = { flow: '' };
const newContents = print(docblock);
console.log(newContents);
The comment-parser package is similar to jest-docblock in that it is used to parse comments in code. It supports parsing of block comments in various formats and is not tied to any specific testing framework, making it more flexible for different use cases.
Doctrine is another JSDoc parsing library that can extract type information and other metadata from JSDoc comments. It is more focused on the JSDoc standard and provides a detailed AST of the parsed comments, which can be more powerful but also more complex than jest-docblock.
jsdoc-to-markdown is a package that takes JSDoc comments and converts them into markdown documentation. While it is not a direct alternative to jest-docblock, it serves a related purpose by transforming code comments into user-friendly documentation.
jest-docblock
is a package that can extract and parse a specially-formatted comment called a "docblock" at the top of a file.
A docblock looks like this:
/**
* Stuff goes here!
*/
Docblocks can contain pragmas, which are words prefixed by @
:
/**
* Pragma incoming!
*
* @flow
*/
Pragmas can also take arguments:
/**
* Check this out:
*
* @myPragma it is so cool
*/
jest-docblock
can:
# with yarn
$ yarn add jest-docblock
# with npm
$ npm install jest-docblock
const code = `
/**
* Everything is awesome!
*
* @everything is:awesome
* @flow
*/
export const everything = Object.create(null);
export default function isAwesome(something) {
return something === everything;
}
`;
const {
extract,
strip,
parse,
parseWithComments,
print,
} = require('jest-docblock');
const docblock = extract(code);
console.log(docblock); // "/**\n * Everything is awesome!\n * \n * @everything is:awesome\n * @flow\n */"
const stripped = strip(code);
console.log(stripped); // "export const everything = Object.create(null);\n export default function isAwesome(something) {\n return something === everything;\n }"
const pragmas = parse(docblock);
console.log(pragmas); // { everything: "is:awesome", flow: "" }
const parsed = parseWithComments(docblock);
console.log(parsed); // { comments: "Everything is awesome!", pragmas: { everything: "is:awesome", flow: "" } }
console.log(print({pragmas, comments: 'hi!'})); // /**\n * hi!\n *\n * @everything is:awesome\n * @flow\n */;
extract(contents: string): string
Extracts a docblock from some file contents. Returns the docblock contained in contents
. If contents
did not contain a docblock, it will return the empty string (""
).
strip(contents: string): string
Strips the top docblock from a file and return the result. If a file does not have a docblock at the top, then return the file unchanged.
parse(docblock: string): {[key: string]: string | string[] }
Parses the pragmas in a docblock string into an object whose keys are the pragma tags and whose values are the arguments to those pragmas.
parseWithComments(docblock: string): { comments: string, pragmas: {[key: string]: string | string[]} }
Similar to parse
except this method also returns the comments from the docblock. Useful when used with print()
.
print({ comments?: string, pragmas?: {[key: string]: string | string[]} }): string
Prints an object of key-value pairs back into a docblock. If comments
are provided, they will be positioned on the top of the docblock.
26.0.0
[jest-environment-jsdom]
[BREAKING] Upgrade jsdom
to v16 (#9606)[@jest/fake-timers]
Add possibility to use a modern implementation of fake timers, backed by @sinonjs/fake-timers
(#7776)[jest-runtime]
Add createMockFromModule
as an alias for genMockFromModule
(#9962)[babel-jest]
Handle null
being passed to createTransformer
(#9955)[jest-circus, jest-console, jest-jasmine2, jest-reporters, jest-util, pretty-format]
Fix time durating formatting and consolidate time formatting code (#9765)[jest-circus]
[BREAKING] Fail tests if a test takes a done callback and have return values (#9129)[jest-circus]
[BREAKING] Throw a proper error if a test / hook is defined asynchronously (#8096)[jest-circus]
Throw more descriptive error if hook is defined inside test (#9957)[jest-circus]
[BREAKING] Align execution order of tests to match jasmine
's top to bottom order (#9965)[jest-config, jest-resolve]
[BREAKING] Remove support for browser
field (#9943)[jest-haste-map]
Stop reporting files as changed when they are only accessed (#7347)[jest-resolve]
Show relative path from root dir for module not found
errors (#9963)[jest-runtime]
Fix absolute path moduleNameMapper + jest.mock bug (#8727)[*]
[BREAKING] TypeScript definitions requires a minimum of TypeScript v3.8 (#9823)[*]
[BREAKING] Drop support for Node 8 (#9423)[*]
Upgrade to chalk@4 (#9752)[*]
Remove usage of realpath-native
(#9952)[docs]
Fix example reference implementation to use Jest with Phabricator (#8662)[docs]
Added default compiler to transform (#8583)[docs]
Updated Testing Frameworks guide with React; make it generic (#9106)[expect, jest-mock, pretty-format]
[BREAKING] Remove build-es5
from package (#9945)[@jest/fake-timers, @jest/environment]
[BREAKING] Rename LolexFakeTimers
to ModernFakeTimers
(#9960)[jest-haste-map]
[BREAKING] removed providesModuleNodeModules
(#8535)[jest-runtime]
[BREAKING] Remove long-deprecated require.requireActual
and require.requireMock
methods (#9854)FAQs
`jest-docblock` is a package that can extract and parse a specially-formatted comment called a "docblock" at the top of a file.
The npm package jest-docblock receives a total of 15,160,508 weekly downloads. As such, jest-docblock popularity was classified as popular.
We found that jest-docblock demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.